API Object Definitions

Objects/Classes used in API Methods

Objects / Classes

AddHierarchyOverlayApiObject

An object representing the hierarchy overlays to be applied to a data model.

AddMeasureOverlayApiObject

An object representing the measure overlays to be applied to a data model.

AddUserRoleData

An object for defining which user is attached to a role.

AddUsersRoleData

An object for defining which users are attached a role.

AdditionalServerProperties

Additional data source connection properties and settings used OPTIONALLY for different server types.

AdminMultiTenantData

The tenant object contains all relevant meta-data for the tenant.

AdminTypeApiData

The admin type object contains the admin settings for a given user.

AnalystProfileApiData

An object that contains the profile definition for analyst users.

AnalyticsPermissions

The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied

ApiResultLicenseStatus

An object containing the license status

ApiResultTaskStatus

An object containing the task status

AttributeTranslation

Describes translations for attribute

BaseUserOpenIdCredentials

The user credentials for authentication by OpenID parameter map.

BaseUserSamlCredentials

The user credentials for authentication by SAML token.

CartesianCategoriesDropZone

Settings for the Categories drop zone for the Cartesian visual

CartesianCategoriesHierarchyChip

Settings for the Categories hierarchy drop zone chip for the Cartesian visual

CartesianColorChip

Settings for the Color drop zone chip for the Cartesian visual

CartesianColorDropZone

Settings for the Color drop zone for the Cartesian visual

CartesianColorHierarchyChip

Settings for the Color hierarchy drop zone chip for the Cartesian visual

CartesianColorMeasureChip

Settings for the Color measure drop zone chip for the Cartesian visual

CartesianFilterChip

Settings for the Filter drop zone chip for the Cartesian visual

CartesianFilterDropZone

Settings for the Filter drop zone for the Cartesian visual

CartesianFilterHierarchyChip

Settings for the Filter hierarchy drop zone chip for the Cartesian visual

CartesianFilterValuesChip

Settings for the Filter values drop zone chip for the Cartesian visual

CartesianLabelsChip

Settings for the Labels drop zone chip for the Cartesian visual

CartesianLabelsDropZone

Settings for the Labels drop zone for the Cartesian visual

CartesianLabelsHierarchyChip

Settings for the Labels hierarchy drop zone chip for the Cartesian visual

CartesianLabelsMeasureChip

Settings for the Labels measure drop zone chip for the Cartesian visual

CartesianMotionDropZone

Settings for the Motion drop zone for the Cartesian visual

CartesianMotionHierarchyChip

Settings for the Motion hierarchy drop zone chip for the Cartesian visual

CartesianShapeChip

Settings for the Shape drop zone chip for the Cartesian visual

CartesianShapeDropZone

Settings for the Shape drop zone for the Cartesian visual

CartesianShapeHierarchyChip

Settings for the Shape hierarchy drop zone chip for the Cartesian visual

CartesianShapeMeasureChip

Settings for the Shape measure drop zone chip for the Cartesian visual

CartesianSizeDropZone

Settings for the Size drop zone for the Cartesian visual

CartesianSizeMeasureChip

Settings for the Size measure drop zone chip for the Cartesian visual

CartesianTooltipChip

Settings for the Tooltip drop zone chip for the Cartesian visual

CartesianTooltipDropZone

Settings for the Tooltip drop zone for the Cartesian visual

CartesianTooltipHierarchyChip

Settings for the Tooltip hierarchy drop zone chip for the Cartesian visual

CartesianTooltipMeasureChip

Settings for the Tooltip measure drop zone chip for the Cartesian visual

CartesianTrellisHorizontalChip

Settings for the TrellisHorizontal drop zone chip for the Cartesian visual

CartesianTrellisHorizontalDropZone

Settings for the TrellisHorizontal drop zone for the Cartesian visual

CartesianTrellisHorizontalHierarchyChip

Settings for the TrellisHorizontal hierarchy drop zone chip for the Cartesian visual

CartesianTrellisHorizontalValuesChip

Settings for the TrellisHorizontal values drop zone chip for the Cartesian visual

CartesianTrellisVerticalChip

Settings for the TrellisVertical drop zone chip for the Cartesian visual

CartesianTrellisVerticalDropZone

Settings for the TrellisVertical drop zone for the Cartesian visual

CartesianTrellisVerticalHierarchyChip

Settings for the TrellisVertical hierarchy drop zone chip for the Cartesian visual

CartesianTrellisVerticalValuesChip

Settings for the TrellisVertical values drop zone chip for the Cartesian visual

CartesianValuesDropZone

Settings for the Values drop zone for the Cartesian visual

CartesianValuesMeasureChip

Settings for the Values measure drop zone chip for the Cartesian visual

CartesianValuesVisualTypes

Settings for the Values measure drop zone chip for the Cartesian visual

CartesianVisual

Settings for the Cartesian visual

ChangeItemDescriptionData

The change object used to set a description for a given content item.

ChangeUserLicenseObject

The change license type object contains the license settings for a given user.

ConnStringDscApiObject

The import content items result object from importing content into the system.

ConnectedItemsSearchCriteria

The search criteria for finding materialized data elements.

ConnectionSearchCriteria

The search criteria for finding data sources connections and their properties.

ConnectionStringData

The connection object representing the details of the data sources

ConnectionStringProperties

The connection object representing the details of the data sources.

ContentSearchParamsObject

The content search object for specifying search criteria to be used in content searches.

CreateRoleData

The role creation object contains meta-data for the role.

CreateUserAdObject

The object used to create a new user when AD authentication is used.

CreateUserDbObject

The object used to create a new user when DB authentication is used.

CreateUserFromSearchObject

The object used to create a new user from search.

CreateUserObject

Represents a user to be updated in the system

CreateUserOpenIdObject

The object used to create a new user when OpenID authentication is used.

CreateUserSamlObject

The object used to create a new user when SAML authentication is used.

CreatedThemeResult

The returned Object when importing a theme.

DataBaseRecognitionObject

The database and its details object.

DataCatalogDimension

Describes a Dimension/Table in the model

DataCatalogHierarchy

Describes a Hierarchy/Column in Dimension/Table

DataCatalogHierarchyLevel

Describes a level of a hierarchy

DataCatalogItem

Describes an Item in the data catalog

DataCatalogMeasure

Describes a Measure in the model

DataCatalogModelMetadata

Describes the metadata of the discover object

DataCatalogProperty

Describes a property of Hierarchy, Column or Hierarchy Level

DataCatalogUpdateData

Data for data catalog update operation

DataSourceTableResult

A data flow table, can be information of a direct query table or information of a table node.

DataSourceUsedTablesResult

List of used tables of a data source node within a data flow.

DeleteHierarchyOverlayApiObject

An object representing the hierarchy overlays to be deleted from a data model.

DeleteMeasureOverlayApiObject

An object representing the measure overlays to be deleted from a data model.

DeleteTenantApiData

The listing of tenants that will be removed from the system.

DiscoverData

Metadata details of the Discover item

DiscoverDataCatalog

Describes the discover model

DomainAdminPermissionAPIObject

An object that contains the profile permission for domain admin users.

DomainAdminPermissions

The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied

DomainSecurityObject

The security settings object.

DscApiData

The data source changer settings object.

ElementSelectionData

Describes single selection in hierarchy

EnumerationOutput

The members/elements contained in a Formulation parameter

ErrorMessage

Describes error details

ExecuteMasterFlowObject

Input parameters needed to execute a Master Flow

ExecuteMasterFlowResult

Execute master flow result

ExecuteScheduleApiData

An object for settings the execution parameters of a schedule.

ExecutionSettings

Advanced Query Features

ExecutionViewData

The execution object contains all the details of scheduled execution instance.

ExportContentApiData

The object representing the details for which items to export with two booleans.

ExportData

The object representing the exported PIE file.

ExportOptions

The query export options object used to set optional switches.

ExternalGroupIdentifier

The object used to specify groups in the external IDP.

ExternalGroupModel

Represents an external group

ExternalParameters

The parameter object used to specify filters and targets to be used to parameterize the query in the export.

ExternalSearchObject

The search object used to find items in the external IDP.

ExternalUserIdentifier

The object used to specify users in the external IDP.

ExternalUserModel

Represents an external user

FailedItemId

A generic object used to contain ID of item.

FilterParameter

The filter parameter object used to specify filters for parameterizing queries.

FolderTenantObject

The folder for a tenant object.

FormulaData

The details of the Formula to add to the system.

FtpSettings

Settings for FTP server connections

GetFolderItemsObject

The object for getting the folder items

GetItemParamsObject

The search configuration for specifying the criteria to be used

GetOverlaySecurityObject

An object representing the data model overlay / security.

GridColorChip

Settings for the Color drop zone chip for the Grid visual

GridColorDropZone

Settings for the Color drop zone for the Grid visual

GridColorHierarchyChip

Settings for the Color hierarchy drop zone chip for the Grid visual

GridColorMeasureChip

Settings for the Color measure drop zone chip for the Grid visual

GridColsChip

Settings for the Cols drop zone chip for the Grid visual

GridColsDropZone

Settings for the Cols drop zone for the Grid visual

GridColsHierarchyChip

Settings for the Cols hierarchy drop zone chip for the Grid visual

GridColsValuesChip

Settings for the Cols values drop zone chip for the Grid visual

GridFilterChip

Settings for the Filter drop zone chip for the Grid visual

GridFilterDropZone

Settings for the Filter drop zone for the Grid visual

GridFilterHierarchyChip

Settings for the Filter hierarchy drop zone chip for the Grid visual

GridFilterValuesChip

Settings for the Filter values drop zone chip for the Grid visual

GridIndicatorDropZone

Settings for the Indicator drop zone for the Grid visual

GridIndicatorMeasureChip

Settings for the Indicator measure drop zone chip for the Grid visual

GridRowsChip

Settings for the Rows drop zone chip for the Grid visual

GridRowsDropZone

Settings for the Rows drop zone for the Grid visual

GridRowsHierarchyChip

Settings for the Rows hierarchy drop zone chip for the Grid visual

GridRowsValuesChip

Settings for the Rows values drop zone chip for the Grid visual

GridSizeDropZone

Settings for the Size drop zone for the Grid visual

GridSizeMeasureChip

Settings for the Size measure drop zone chip for the Grid visual

GridTooltipChip

Settings for the Tooltip drop zone chip for the Grid visual

GridTooltipDropZone

Settings for the Tooltip drop zone for the Grid visual

GridTooltipHierarchyChip

Settings for the Tooltip hierarchy drop zone chip for the Grid visual

GridTooltipMeasureChip

Settings for the Tooltip measure drop zone chip for the Grid visual

GridValuesDropZone

Settings for the Values drop zone for the Grid visual

GridValuesMeasureChip

Settings for the Values measure drop zone chip for the Grid visual

GridVisual

Settings for the Grid visual

HierarchyElementSelection

Describes the element selection for a given hierarchy

HierarchyMeasureSecurity

Details of the security settings to be applied to a data model's hierarchies or measures.

HierarchyMeasureSecurityApiObject

Details of the security settings to be applied to a data model's hierarchies or measures.

HierarchyOverlayData

Metadata overlay of a data model's hierarchy to add. If a property isn't passed then its existing value stays.

HierarchyOverlayToDeleteData

Hierarchy overlay data to delete.

HubApiObject

An object containing the details of the Hub template archive.

ImportApiResultObject

The import content items result object from importing content into the system.

ImportMaterializedModelObject

The object representing the details for where to import a model PIE file.

ItemId

A generic object used to contain ID of item.

ItemParentApiData

The item-parent object used to set the content item's parent item ID.

ItemRolePair

Object with role and role access types.

ItemRolesForRemoval

Object with roles and items to be removed.

ItemRolesToBeAdded

Object with roles and items to be added.

ItemsForFavorites

The listing of favorite content items for a user.

ItemsToCopy

The copy items object with details of the selected content items and the destination folder.

ItemsToMove

The move items object with details of the selected content items and the destination folder.

LdapGroupDetails

The LDAP group object contains a list of all Active Directory groups.

LdapGroupIdentifier

The LDAP/AD group object.

LdapSearchObject

The LDAP search object that contains the parameters to be used in Active Directory searches.

LdapUserObject

The LDAP user object contains a list of all Active Directory users.

LdapUsersSearchObject

The LDAP search object used to find users in the LDAP directory.

LicenseCountObject

Object which represents the total numbers of Pro and Viewer user licenses

ListData

The Custom List To add.

MSOlapProperties

Additional properties for olap sources on calculation.

MapColorChip

Settings for the Color drop zone chip for the Map visual

MapColorDropZone

Settings for the Color drop zone for the Map visual

MapColorHierarchyChip

Settings for the Color hierarchy drop zone chip for the Map visual

MapColorMeasureChip

Settings for the Color measure drop zone chip for the Map visual

MapDetailsDropZone

Settings for the Details drop zone for the Map visual

MapDetailsHierarchyChip

Settings for the Details hierarchy drop zone chip for the Map visual

MapFilterDropZone

Settings for the Filter drop zone for the Map visual

MapFilterHierarchyChip

Settings for the Filter hierarchy drop zone chip for the Map visual

MapLocationChip

Settings for the Location drop zone chip for the Map visual

MapLocationDropZone

Settings for the Location drop zone for the Map visual

MapLocationHierarchyChip

Settings for the Location hierarchy drop zone chip for the Map visual

MapLocationMeasureChip

Settings for the Location measure drop zone chip for the Map visual

MapMotionDropZone

Settings for the Motion drop zone for the Map visual

MapMotionHierarchyChip

Settings for the Motion hierarchy drop zone chip for the Map visual

MapSizeDropZone

Settings for the Size drop zone for the Map visual

MapSizeMeasureChip

Settings for the Size measure drop zone chip for the Map visual

MapTooltipChip

Settings for the Tooltip drop zone chip for the Map visual

MapTooltipDropZone

Settings for the Tooltip drop zone for the Map visual

MapTooltipHierarchyChip

Settings for the Tooltip hierarchy drop zone chip for the Map visual

MapTooltipMeasureChip

Settings for the Tooltip measure drop zone chip for the Map visual

MapVisual

Settings for the Map visual

MasterFlowExecutionPathElement

Describes the path of the node in the execution

MasterFlowFindDataSourceObject

Use this object to find a specific data source

MasterFlowModelNameObject

Use this object to update model name.

MasterFlowOtherObject

The master flow object contains information about the details of a specific master flow or data flow node and the validation message

MasterFlowProgressLogItem

Item in the Progress log of a master flow execution

MasterFlowProgressLogRequest

Describes request for the progress logs of masterflow execution

MasterFlowProgressResult

The master flow progress update

MasterFlowSchemasObject

Use this object to update the database schemas used in the data flow.

MasterFlowSourceConnectionObject

Use this object to modify the data source server and/or the database in a data flow.

MasterFlowSourceObject

The master flow data source object contains information about the connection of a specific source ETL node or master flow sql script node and the validation message result

MasterFlowTargetConnectionObject

Use this object to modify the data target server and/or the database in a data flow.

MasterFlowTargetObject

The master flow target object contains information about the connection of a specific target ETL node and the validation message result

MasterFlowUpdatedVariableResult

The master flow updated list of variables result

MasterFlowValidationResult

Validation result, includes list for each validation type object

MasterFlowVariableConnectionObject

Use this object to modify the data source server ID or/and database name used in the variable connection.

MasterFlowVariableObject

The master flow variable object contains information about the connection of a specific variable and the validation message result

MasterFlowVariableValueObject

Use this object to modify a variable's value.

MasterFlowVariablesResult

List of variables based on a query with all their connection details

MasterFlowVariablesValueObject

Use this object to modify the values of a list of variables used in a Master Flow.

MaterializedApiObject

The object representing the details for where to import a model PIE file.

MaterializedItemObject

The search results object.

MeasureGroup

A fact table grouping. If table A has measures on it, and table B is connected to it, then table B has MeasureGroup of table A

MeasureOverlayData

Metadata overlay of a data model's measure to add. If a property isn't passed then its existing value stays.

MeasureOverlayToDeleteData

Measure overlay data to delete.

MemberDataApi

Describe the information about a single member

MembersSecurity

The details of the security settings for the hierarchy's member elements.

MembersSecurityApiObject

The details of the security settings for the hierarchy's member elements.

MetaDataTranslation

Describes translations for metadata

ModelDataCatalog

Describes the data catalog

ModelDataFlowSourceInfo

Info about the source Data Flow used to drive this model

ModelProcessDateObject

The connection string id and the new model process date to be updated.

ModelProcessDateResult

The result from updating a model's process date

ModelRecognitionObject

The model and its details.

ModelScheduleOnDemandObject

Details of the model that will be the target of the on-demand execution.

ModelScheduleOnDemandResult

A listing of on-demand schedules triggered by the change

ModelSyncColumnsSettings

The default setting for every new column that will be added as a part of the automatic synchronization of the model during the scheduling process.

ModelingAggregationMapping

This mapping is been used when a ModelingTable has been defined as an Aggregated Table to determine the link between the aggregated column to the target column / measure

ModelingColumn

Definition of a table column in the model.

ModelingConfigTranslation

Model configuration for a specific language.

ModelingFolderTranslations

Describes the translations for specific folder

ModelingHierarchy

Hierarchy definition in the model. A hierarchy is defined by a list of levels, each defined by a column

ModelingHierarchyLevel

Definition of a hierarchy level in the model definition, contains source column identifier.

ModelingMeasure

Definition of a measure in the model definition, contains column unique identifies, aggregation, etc.

ModelingModel

The model definition that contains details of tables, their relationships and joins, and measures.

ModelingProperty

A property column of another column, example: state could have country as a property

ModelingRelationship

Relationship definition used in the models when joining across tables columns.

ModelingRelationshipColumnPair

A pair of linked columns used to define a relationship in the model definition. A relationship can be defined by 1 or more pairs.

ModelingServerInfo

Describe the details about the server that the current model is based on.

ModelingTable

Table definition in a model, contains table schema, name, columns, etc.

ModelingTranslation

Definition of general model translations. other translations are inside the table, column, measure, hierarchy objects

ModifiedItemsResult

Generic API response object with success or failure flag and related messages.

ModifiedUsersResult

Generic API response object with success or failure flag and related messages.

NewFolderApiData

The listing of content items object.

NlpQueryExportData

The query export object used to specify how to extract nlp query results.

NotificationIndicatorsRequest

Describes request for notification indicators.

NotificationIndicatorsResult

List of notification indicator counts for unread items.

OauthDataSourceSettings

Additional setting for OauthDataSources

OdbcDirectQueryOptions

Additional query information for ODBC Direct data source

PieApiObject

The object representing the details for where to import a PIE file of content.

ProPermissions

The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied

ProProfileApiData

An object that contains the profile definition for pro users.

ProfileApiData

The Profile definition object contains the definition for a user profile.

ProfilePermissionHolder

The functional items to be available in the profile as either a list or the sum bit indexes. The list will take priority if both are supplied

ProfileRolesData

The profile-role object contains a list of all roles to add or remove for the specified profile.

PulseClientData

Data payload with details on the Pulse clients

PyramidContentItem

Pyramid Content item object.

PyramidItemIdentifier

The item idenifier object.

PyramidUserObject

The user object contains all relevant meta-data for the user.

PyramidViewUserObject

The user object contains all relevant meta-data for the user.

QueryExportData

The query export object used to specify how to extract query results.

QueryOptions

Advanced Query Features

QueryTotalSettings

Defines the total settings for the Rows/Columns

RelatedItemData

Represents an item related data

RenameItemApiData

The rename object for settings to rename content items.

RoleAdGroupsModifyObject

The user object contains all relevant meta-data for the user.

RoleData

The role object contains meta-data for the role.

RoleGroupModifyObject

The user object contains all relevant meta-data for the user.

RoleMinimalData

The 'minimal' role object contains basic meta-data for the role.

RoleToItemApiData

The role object with settings to be set for the chosen content item.

RolesInItemRemovalObject

The role object with settings to be set for the chosen content item.

ScatterColorChip

Settings for the Color drop zone chip for the Scatter visual

ScatterColorDropZone

Settings for the Color drop zone for the Scatter visual

ScatterColorHierarchyChip

Settings for the Color hierarchy drop zone chip for the Scatter visual

ScatterColorMeasureChip

Settings for the Color measure drop zone chip for the Scatter visual

ScatterDetailsDropZone

Settings for the Details drop zone for the Scatter visual

ScatterDetailsHierarchyChip

Settings for the Details hierarchy drop zone chip for the Scatter visual

ScatterFilterChip

Settings for the Filter drop zone chip for the Scatter visual

ScatterFilterDropZone

Settings for the Filter drop zone for the Scatter visual

ScatterFilterHierarchyChip

Settings for the Filter hierarchy drop zone chip for the Scatter visual

ScatterFilterValuesChip

Settings for the Filter values drop zone chip for the Scatter visual

ScatterLabelsChip

Settings for the Labels drop zone chip for the Scatter visual

ScatterLabelsDropZone

Settings for the Labels drop zone for the Scatter visual

ScatterLabelsHierarchyChip

Settings for the Labels hierarchy drop zone chip for the Scatter visual

ScatterLabelsMeasureChip

Settings for the Labels measure drop zone chip for the Scatter visual

ScatterMotionDropZone

Settings for the Motion drop zone for the Scatter visual

ScatterMotionHierarchyChip

Settings for the Motion hierarchy drop zone chip for the Scatter visual

ScatterShapeChip

Settings for the Shape drop zone chip for the Scatter visual

ScatterShapeDropZone

Settings for the Shape drop zone for the Scatter visual

ScatterShapeHierarchyChip

Settings for the Shape hierarchy drop zone chip for the Scatter visual

ScatterShapeMeasureChip

Settings for the Shape measure drop zone chip for the Scatter visual

ScatterSizeDropZone

Settings for the Size drop zone for the Scatter visual

ScatterSizeMeasureChip

Settings for the Size measure drop zone chip for the Scatter visual

ScatterTooltipChip

Settings for the Tooltip drop zone chip for the Scatter visual

ScatterTooltipDropZone

Settings for the Tooltip drop zone for the Scatter visual

ScatterTooltipHierarchyChip

Settings for the Tooltip hierarchy drop zone chip for the Scatter visual

ScatterTooltipMeasureChip

Settings for the Tooltip measure drop zone chip for the Scatter visual

ScatterTrellisHorizontalChip

Settings for the TrellisHorizontal drop zone chip for the Scatter visual

ScatterTrellisHorizontalDropZone

Settings for the TrellisHorizontal drop zone for the Scatter visual

ScatterTrellisHorizontalHierarchyChip

Settings for the TrellisHorizontal hierarchy drop zone chip for the Scatter visual

ScatterTrellisHorizontalValuesChip

Settings for the TrellisHorizontal values drop zone chip for the Scatter visual

ScatterTrellisVerticalChip

Settings for the TrellisVertical drop zone chip for the Scatter visual

ScatterTrellisVerticalDropZone

Settings for the TrellisVertical drop zone for the Scatter visual

ScatterTrellisVerticalHierarchyChip

Settings for the TrellisVertical hierarchy drop zone chip for the Scatter visual

ScatterTrellisVerticalValuesChip

Settings for the TrellisVertical values drop zone chip for the Scatter visual

ScatterVisual

Settings for the Scatter visual

ScatterXValuesDropZone

Settings for the XValues drop zone for the Scatter visual

ScatterXValuesMeasureChip

Settings for the XValues measure drop zone chip for the Scatter visual

ScatterYValuesDropZone

Settings for the YValues drop zone for the Scatter visual

ScatterYValuesMeasureChip

Settings for the YValues measure drop zone chip for the Scatter visual

ScheduleSearchCriteria

The search criteria object for finding a schedule.

ScheduleViewObject

The schedule listing object.

ScientistPermissions

The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied

ScientistProfileApiData

An object that contains the profile definition for scientist users.

SearchAdGroupUsersData

The LDAP search object that contains the parameters to be used in Active Directory searches.

SearchAdUserGroupsData

The LDAP search object that contains the parameters to be used in Active Directory searches.

SearchCriteria

The search object to be used for providing search settings.

SegmentColorChip

Settings for the Color drop zone chip for the Segment visual

SegmentColorDropZone

Settings for the Color drop zone for the Segment visual

SegmentColorHierarchyChip

Settings for the Color hierarchy drop zone chip for the Segment visual

SegmentColorMeasureChip

Settings for the Color measure drop zone chip for the Segment visual

SegmentDetailsDropZone

Settings for the Details drop zone for the Segment visual

SegmentDetailsHierarchyChip

Settings for the Details hierarchy drop zone chip for the Segment visual

SegmentFilterChip

Settings for the Filter drop zone chip for the Segment visual

SegmentFilterDropZone

Settings for the Filter drop zone for the Segment visual

SegmentFilterHierarchyChip

Settings for the Filter hierarchy drop zone chip for the Segment visual

SegmentFilterValuesChip

Settings for the Filter values drop zone chip for the Segment visual

SegmentLabelsChip

Settings for the Labels drop zone chip for the Segment visual

SegmentLabelsDropZone

Settings for the Labels drop zone for the Segment visual

SegmentLabelsHierarchyChip

Settings for the Labels hierarchy drop zone chip for the Segment visual

SegmentLabelsMeasureChip

Settings for the Labels measure drop zone chip for the Segment visual

SegmentMotionDropZone

Settings for the Motion drop zone for the Segment visual

SegmentMotionHierarchyChip

Settings for the Motion hierarchy drop zone chip for the Segment visual

SegmentSizeDropZone

Settings for the Size drop zone for the Segment visual

SegmentSizeMeasureChip

Settings for the Size measure drop zone chip for the Segment visual

SegmentTooltipChip

Settings for the Tooltip drop zone chip for the Segment visual

SegmentTooltipDropZone

Settings for the Tooltip drop zone for the Segment visual

SegmentTooltipHierarchyChip

Settings for the Tooltip hierarchy drop zone chip for the Segment visual

SegmentTooltipMeasureChip

Settings for the Tooltip measure drop zone chip for the Segment visual

SegmentTrellisHorizontalChip

Settings for the TrellisHorizontal drop zone chip for the Segment visual

SegmentTrellisHorizontalDropZone

Settings for the TrellisHorizontal drop zone for the Segment visual

SegmentTrellisHorizontalHierarchyChip

Settings for the TrellisHorizontal hierarchy drop zone chip for the Segment visual

SegmentTrellisHorizontalValuesChip

Settings for the TrellisHorizontal values drop zone chip for the Segment visual

SegmentTrellisVerticalChip

Settings for the TrellisVertical drop zone chip for the Segment visual

SegmentTrellisVerticalDropZone

Settings for the TrellisVertical drop zone for the Segment visual

SegmentTrellisVerticalHierarchyChip

Settings for the TrellisVertical hierarchy drop zone chip for the Segment visual

SegmentTrellisVerticalValuesChip

Settings for the TrellisVertical values drop zone chip for the Segment visual

SegmentValuesDropZone

Settings for the Values drop zone for the Segment visual

SegmentValuesMeasureChip

Settings for the Values measure drop zone chip for the Segment visual

SegmentVisual

Settings for the Segment visual

ServerData

The data source server object and its settings.

SimpleModifierResult

Generic API response object with success or failure flag and related messages.

TabularColorChip

Settings for the Color drop zone chip for the Tabular visual

TabularColorDropZone

Settings for the Color drop zone for the Tabular visual

TabularColorHierarchyChip

Settings for the Color hierarchy drop zone chip for the Tabular visual

TabularColorMeasureChip

Settings for the Color measure drop zone chip for the Tabular visual

TabularColsChip

Settings for the Cols drop zone chip for the Tabular visual

TabularColsDropZone

Settings for the Cols drop zone for the Tabular visual

TabularColsHierarchyChip

Settings for the Cols hierarchy drop zone chip for the Tabular visual

TabularColsMeasureChip

Settings for the Cols measure drop zone chip for the Tabular visual

TabularFilterDropZone

Settings for the Filter drop zone for the Tabular visual

TabularFilterHierarchyChip

Settings for the Filter hierarchy drop zone chip for the Tabular visual

TabularSizeDropZone

Settings for the Size drop zone for the Tabular visual

TabularSizeMeasureChip

Settings for the Size measure drop zone chip for the Tabular visual

TabularTooltipChip

Settings for the Tooltip drop zone chip for the Tabular visual

TabularTooltipDropZone

Settings for the Tooltip drop zone for the Tabular visual

TabularTooltipHierarchyChip

Settings for the Tooltip hierarchy drop zone chip for the Tabular visual

TabularTooltipMeasureChip

Settings for the Tooltip measure drop zone chip for the Tabular visual

TabularVisual

Settings for the Tabular visual

TagData

The tag object used to capture a tag's settings.

TagUsageApiData

The tag usage object used to set a tag for a given content item.

TargetParameter

The target parameter object used to specify target and its filters for parameterizing queries.

TaskSummary

The task Log message

TaskUserApiData

An object specifying the requested task id and user id .

TaskViewData

Execution Tasks object with details of a scheduled job task.

TenantLicenseTypeData

The tenant license object with its license type.

TenantObject

The tenant object.

TenantSettings

The tenant's miscellaneous settings.

TenantUsersGetObject

The tenant object for fetching users.

ThemeApiObject

The theme object holding the definition of a theme.

ThemeListObject

The object of theme ID's and names

ThemeToItemsApiObject

An object containing theme id and the item ids that should contain this theme.

TogglePauseDatasourceApiData

The toggle object to indicate the datasource state in the system.

ToggleUserApiData

The toggle object to indicate the user state in the system.

TotalsSettings

Defines the total settings of the discover

UpdateTenantSeatsObject

The tenant object for updating tenant seats.

UpdateUserAdObject

The object used to update an AD/LDAP based user.

UpdateUserDbObject

The object used to update a database authentication user.

UpdateUserFromSearchObject

The object used to update a user from search.

UpdateUserObject

Represents a user to be updated in the system

UpdateUserOpenIdObject

The object used to update a OpenID user.

UpdateUserSamlObject

The object used to update a SAML user.

UserCredentials

The user credential object used to set a user's login settings.

UserOpenIdCredentials

The user credentials for authentication by OpenID parameter map.

UserPhone

Describes User Phone details

UserRolesData

The user-role object contains a list of all roles to add or remove for the specified user.

UserSamlCredentials

The user credentials for authentication by SAML token.

UserTokenCredentials

The user credentials for authentication by token.

ViewerPermissions

The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied

ViewerProfileApiData

An object that contains the profile definition for viewer users.

Visuals

All the dropzones of the visuals by groups